home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 1.iso / ARGONET / PD / UTILITIES / STDFIND.SPK / !STDFinder / Readme < prev    next >
Text File  |  1995-07-02  |  11KB  |  224 lines
  1. ***************************************************************************
  2. *                                                                         *
  3. *                       !STDFinder Version 3.00                           *
  4. *                          By Julyan Bristow                              *
  5. *                                                                         *
  6. ***************************************************************************
  7.  
  8. This is the Readme file for the !STDFinder application, Version 3.00,
  9. released July 1995.
  10.  
  11. 1.0 Overview
  12.  
  13. The purpose of this program is to provide fast search facilites for a STD
  14. code database.  Both the town or code may be entered as the search
  15. criteria, and wild cards are permitted in the search string.  Export of the
  16. complete database, or a subset of the database is supported.  A database of
  17. the main STD codes is provided as the default database.  Further databases
  18. of city codes may be imported, and the new modified database may then be
  19. saved as the new default.
  20.  
  21. The program is a fully RISC OS compliant application, and has been tested on 
  22. a RISC PC.
  23.  
  24. This program is a significant rewrite of !STDFinder Version 2.02, dated
  25. 28-March-1995.  Those users who already hace a copy of this version of the
  26. application are advised to skip to section 5.0, which describes the major
  27. differences between version 2.02 and this version, 3.0.
  28.  
  29. 2.0 The Program
  30.  
  31. To start the program, double click on the icon in the normal way.  An icon
  32. will install on the iconbar.  Clicking the mouse 'menu' button brings up a
  33. menu, with the following options:
  34.  
  35.         Info            Details of the current application version
  36.         Search          Start the main part of the application
  37.         Quit            Quit the application
  38.  
  39. In addition, the application may be started by clicking with the mouse
  40. 'select' button on the icon.
  41.  
  42. When the main application is started, a small dialogue box opens in the top
  43. left corner of the screen.  There are four fields that the user may use. 
  44. To start the search, the town or code to be found should be entered in the
  45. box under the menu icons as indicated.
  46.  
  47. To commence the search, either click with the left mouse button on the
  48. 'Search' icon, or press return.  If items in the database match the search
  49. criteria, then those towns and codes will  appear in a window below.  This
  50. can be scrolled to view all entries, should there be more than the number
  51. appearing in the window.  In the event if no matches being made, the Search
  52. Results window will not open.
  53.  
  54. The exact icon affects how the database is searched.  Selection of the
  55. 'exact' option (a tick will appear in the box) means that the database will
  56. be searched only for an exact match of the user's search string. Eg if the
  57. search string is 'Bedworth', then only matches exactly equal to this will be
  58. identified.  This is case sensitive.  This the same for the dialling codes
  59.  
  60. When the exact option is not selected (the default condition), then a match
  61. will be found if the users search string is contained within any of the
  62. entries  of the database.  This is case independent.  Eg if the search 
  63. string is 'worth', then 'Bedworth', 'Bagworthy' and 'Worthing' will all
  64. provide valid matches.
  65.  
  66. A simple wildcard search is permitted.  The wildcard symbol is '*'.
  67.  
  68. Use of wildcards may be clarified as follows; consider the search string
  69. 'worth' once again.
  70.  
  71. If 'worth' is entered (without using wildcards) then 'Bedworth', 'Bagworthy'
  72. and 'Worthing' will all provide valid matches. 
  73.  
  74. However, if 'worth*' is entered then only towns beginning with the string
  75. 'worth' will be found, Eg Worthing.
  76.  
  77. If  '*worth' is entered then only towns with the last 5 characters of
  78. 'worth' will be found, Eg Bedworth.
  79.  
  80. Finally if '*worth*' is entered  then only towns containing the 5 characters
  81. 'worth' in their name,  but not at the start or end will be found, Eg
  82. Bagworthy.
  83.  
  84. If wildcards are not positioned in the first or last position of the search
  85. string, or there are more than two wildcards entered, then an error will be
  86. reported.
  87.  
  88. Wildcards are not permitted with the exact option set to 'on'.
  89.  
  90. When matches have been made, and the 'Search Results' window is open, a
  91. further menu is available.  The Save menu has a submenu leading to two
  92. choices.  The first, 'All', is to save the entire database to a text file. 
  93. The second is to save all the towns meeting the current search criteria to a
  94. text file.  In both cases a default file name is suggested.  The user may
  95. drag the file icon to another directory as required.
  96.  
  97. 3.0 Adding User Directories
  98.  
  99. The default database, which is loaded on startup is called 'Newcodes', and
  100. is stored in the directory 'Directorys', within the !STDFinder application. 
  101. In this directory are also five other database files, four of UK cities and
  102. one of international codes.  These may be added to the currently loaded
  103. database by dragging the file icons to the applications iconbar icon.  As
  104. they are loaded into the database, they are sorted into alphabetical order.
  105.  
  106. There is no check made to see if the dragged database has already been
  107. loaded, therefore it is possible for an additional directory to be loaded
  108. more than once.
  109.  
  110. 3.1 Creating Your Own User Directories
  111.  
  112. As of version 3.00, directory files have been given the filetype 129 (hex). 
  113. This is in attempt to ensure that only files of the correct format are
  114. loaded.  However, the files are still text format and they may be editied
  115. using !EDIT (or a similar editor) by holding down the SHIFT key and double
  116. clicking on the file, if the user wishes to modify one of those supplied.
  117.  
  118. The format of the directory files is as follows:
  119.  
  120. town name (49 characters maximum),std code(8 characters maximum)RETURN
  121.  
  122. This is repeated for each town to be entered.  The RETURN should be omitted
  123. after the last entry.
  124.  
  125. If it is required to convert the users existing dictionary files from the
  126. original text type to the new file type, then proceed as follows (further
  127. information can be obtained from the RISC OS User Guides, and page 23 of
  128. the RISC OS 3 User Guide):
  129.  
  130. Click 'MENU' over the file to be altered
  131. Position mouse pointer over the menu item "File 'your dictionary name'" and
  132. follow the right pointing arrow
  133. A submenu will open.  Position mouse pointer over the 'Set Type' option and
  134. follow the right pointing arrow
  135. In the next submenu, delete the entry that says 'Text' and type '129'
  136. followed by RETURN.  The file will now be of the correct type.
  137.  
  138. 4.0 Modifying the Default Directory, if changes have been made to it from
  139. within the application
  140.  
  141. The file' Newcodes' in the 'Directorys' directory must not be deleted.  If
  142. the user drags an additional directory to the application's icon, when
  143. the user attempts to Quit the program, it will warn that the database has
  144. been modified.  Three options are given at this point: 1 - to discard any
  145. changes; 2 - to save the modified data; or 3 - to cancel the quit operation. 
  146. Selecting 1 will quit the program without saving the changes, 2 will write
  147. the modified database information to the default file 'Newcodes', thus
  148. permanently changing the default database, and 3 will abort the quit option,
  149. and leave the application running.
  150.  
  151. 5.0 Program History and Modifications from Version 2.02
  152.  
  153. This program is a significant rewrite of !STDFinder Version 2.02, dated
  154. 28-March-1995.  The First major aim of the rewrite was for me to write the
  155. source code in a better, more structured way, which I feel has been
  156. achieved.  It is now much easier to maintain the source code.  The second
  157. aim was to make some much needed changes to the program operation, both to
  158. improve RISC OS compliance, and to reduce the resources required to run the
  159. application.  These changes are listed below.
  160.  
  161. 5.1  Reduced memory requirement.  Version 3.00 does not claim any more
  162. memory whilst a search is in progress, and hence the memory requirement is
  163. only related to the memory required to load the default database, and any
  164. user defined databases.  Versions prior to this required additional memory
  165. to store search matches, and this was not fully released back to RISC OS.
  166.  
  167. On my computer, an A440/1, the application requires 544k to run with the
  168. default database loaded.  I am not sure what is required on, for example, a
  169. RISC PC where memory pages are very much smaller.
  170.  
  171. 5.2  Errors when entering the search string, often when wild cards were
  172. used.  This has been improved and should not now occur.
  173.  
  174. 5.3  Greater RISC OS compliance.  For example, the caret is gained when the
  175. search window is opened.  If the search window is open, but obscured by
  176. other windows, clicking on the icon will bring it back to the front.  The
  177. new 3D templates have been provided by David Lenthall.
  178.  
  179. 5.4  The edit database function has been removed.  This was not very
  180. effective in versions prior to this, and it was easier to edit the files
  181. using a standard text editor, eg !EDIT.
  182.  
  183. 5.5  Use of a dedicated file type for the dictionaries.  The file type &129
  184. has been adopted as a dictionary file.  A rather poor icon has been provided
  185. by myself.  If this file type clashes with any other application please let
  186. me know.  This is in an attempt to prevent possible errors by dragging any
  187. text file to the icon.
  188.  
  189. 6  Credits
  190.  
  191. Many thanks are to be offered to Ted Lacey who has updated my original
  192. Newcodes database file to reflect the changes arising from Phone Day on 16
  193. April 1995.  Thanks also to Frank Peddie who provided a number of the UK
  194. city codes.  Thanks to David Lenthall for some suggestions as to possible
  195. improvements, many of which have been implemented.
  196.  
  197. 7  This program is Public Domain.  Please feel free to distribute it as you
  198. wish. Please make sure that all the files listed below are included:
  199.  
  200.         !Boot
  201.         !Run
  202.         !Runimage       The executable code
  203.         !Sprites        The application sprites
  204.         Sprites         The resource sprites 
  205.         Templates       The application template file
  206.         Newcodes        The database of all STD codes
  207.         Directorys      Directory containing the default Newcodes
  208.                         file and various different STD Code directories
  209.                         for some UK cities.
  210.         ReadMe          This file
  211.  
  212. 8  Authors Note
  213.  
  214. I will be very grateful if any mistakes are highlighted and suggestions for
  215. possible improvements are sent to me at the address below.
  216.  
  217. Please write to 
  218.  
  219.         Julyan Bristow
  220.         40 Dunard Road
  221.         SHIRLEY
  222.         SOLIHULL
  223.         WEST MIDLANDS
  224.         B90 2HR